home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Applications 1999 November / SGI IRIX 6.5 Applications 1999 November.iso / dev / insight_dev.idb / usr / share / Insight / samples / SGIHelp / exampleDoc / Makefile.z / Makefile
Encoding:
Makefile  |  1998-10-28  |  8.3 KB  |  242 lines
  1. #!smake -r
  2. # Makefile for making a book
  3. #
  4. # Building books and figures:
  5. # To build the print figures for the book issue the command 'make print',
  6. #    this must be done in order to populate the print directory with your
  7. #    figures - your files must reference the figures from the print
  8. #    directory not the orig directory.
  9. # To build the book issue the command 'make book'.
  10. #
  11. # Cleaning up files:
  12. # To remove the master sgml file and books directory use 'make clean_book'.
  13. # To remove the *.sgm files issue 'make clean_sgm'.
  14. # To clean up all the figures use 'make clean_figures'.
  15. #   Do this only if you really want to clean up your figures directories and
  16. #   you haven't done any figure conversions by hand.
  17. # To clean up everything issue 'make clobber' - this includes the figures.
  18.  
  19. # Edit this file in the locations specified.
  20.  
  21. # Location 1: The TITLE, FULL_TITLE, and VERSION Variables
  22. #
  23. # TITLE defines the short title of the book.  Please verify the
  24. # short title with your production editor.  
  25. #
  26. # This title must be a valid directory name and not contain any special
  27. # characters or a leading '.'  Do not have a trailing space on the TITLE line.
  28. #
  29. # FULL_TITLE defines the full title for the book as it should appear
  30. # next to the icon on an InSight bookshelf.
  31. #
  32. # VERSION defines the version number for this release of the product
  33. # and is displayed when the 'Product Info' item off the 'Help' menu is
  34. # selected.
  35. #
  36. # TITLE = SiliconSurf
  37. # FULL_TITLE = "Silicon Surf Help Book"
  38. # VERSION = 1.0
  39.  
  40. TITLE  = exampleAppXmHelp
  41. FULL_TITLE = "Example App Help Book"
  42. VERSION = 1.0
  43.  
  44. include  ${ROOT}/usr/include/make/commonbookdefs
  45.  
  46. # Location 2: The BOOKSHELF, BOOK_LANG, DOC_TYPE, and HIDDEN Variables
  47. #
  48. # The BOOKSHELF variable defines the bookshelf that the book will
  49. # appear on in the Insight library view. Valid entries for SGI
  50. # Tech Pubs are SGI_EndUser (the default), SGI_Developer, and 
  51. # SGI_Admin. 
  52. #
  53. # The BOOK_ICON variable defines the icon the book will have on the
  54. # bookshelf.  The values available are 'sgi_end_user' for End User books
  55. # 'sgi_admin' for Administrator books, 'sgi_developer' for Developer books,
  56. # 'binder' for Support and other "binder" type books, and 'generic' for all
  57. # other books.  The default is 'generic'.
  58. #
  59. # The BOOK_LANG variable defines the base language of the book and
  60. # changes translator-defined strings in the book to the specified language.
  61. # The supported values are C (the default), which is English; de for
  62. # German; and fr for French.  Case of the letters is important. No other
  63. # values are supported other than C, de, and fr.
  64. #
  65. # The DTD variable defines the Document Type Definition that the
  66. # SGML conforms to.  Currently available options are SGIDOC for the
  67. # standard SGI DTD; XHELP for the XHelp DTD; DOCBOOK for the Davenport
  68. # DocBook DTD, and OTHER for any customized DTD.  Case of the letters
  69. # is important.
  70. #
  71. # If OTHER is specified on the DTD variable then DTD specific
  72. # stylesheets must be created and placed in a directory called 'styles',
  73. # a booklist.txt file must be created, an EBT specific DTD must be
  74. # created and called TITLE.dtd, and if the files needs a MIF to SGML
  75. # translator then that must be specified on a variable called
  76. # OTHER_TRANSLATOR - specifying any other arguments that that translator
  77. # might need - other than the file to translate.
  78. #
  79. # All other DTD's automatically set up these for you.  The default
  80. # is to use the SGIDOC DTD.
  81. #
  82. # The DOC_TYPE variable defines the SGML tag type for the contents of
  83. # the book.  All Tech Pubs books are MANUAL (which is the default) while
  84. # CSD Support books should be SUPPORT.  No other values are supported.
  85. #
  86. # The SORT_ORDER variable defines the order this book should appear on
  87. # the bookshelf.  It is a numeric value that can be used to sort the
  88. # books on a bookshelf.  This number should be gotten from your
  89. # production editor.  A default of 999 is used if none is specified.
  90. #
  91. # The HIDDEN variable defines whether this book will be displayed when
  92. # this book is accessed via the InSight library browser rather than the
  93. # SGIHelp browser from the application. The default is to keep XHELP
  94. # based books hidden and all other's not hidden.
  95. #
  96. # If you need to define a value other than the default, uncomment the
  97. # appropriate line and define the value.
  98. #
  99. BOOKSHELF = /usr/share/Insight/library/SGI_bookshelves/Help
  100. # BOOK_ICON = generic
  101. # BOOK_LANG = C
  102. # DTD = SGIDOC
  103. # DOC_TYPE = MANUAL
  104. # SORT_ORDER = 999
  105. HIDDEN = TRUE
  106.  
  107. # Location 3: The BOOK_FILES Variable
  108. #
  109. # List the content files in *CORRECT* order that they appear in the book.
  110. # DO NOT list any generated files (i.e., TOC, LOT, IX, etc).
  111. # Use trailing '\' for continuing onto the next line.
  112. # Don't end the last line of file names with trailing '\'.
  113. # Each line of filenames after the first line should have a leading 
  114. # tab character.
  115. #
  116. # BOOK_FILES =     front.doc        \
  117. #        ch1.doc  ch2.doc    \
  118. #        appa.doc appb.doc
  119.  
  120. BOOK_FILES = exampleAppXmHelp.Chap.doc exampleAppXmHelp.Gloss.doc
  121.  
  122. # NOTES ON FIGURES: 
  123. #
  124. # Every figure you want to appear in paper and online MUST appear
  125. # only once on the following lines.
  126. #
  127. # All figure names must be listed as they appear in the 'orig' directory.
  128. #
  129. # For any composite figures - list each file on the PRINT_BW line.
  130.  
  131. # Location 4: The PRINT_BW Variable
  132. #
  133. # List the name of each .rgb figure from the orig directory that 
  134. # should be converted to black and white in the print directory.  
  135. # These figures will be converted to color GIF online.
  136. #
  137. # PRINT_BW = figure1.rgb figure2.rgb
  138.  
  139. PRINT_BW = mainwind.rgb
  140.  
  141. # Location 5: The PRINT_COLOR Variable
  142. #
  143. # List the name of each .rgb figure from the orig directory that should
  144. # be kept in color in the print directory.  These figures will be 
  145. # converted to color GIF online.  
  146. #
  147. # Also list any .rgb figures in the orig directory that have been 
  148. # processed to b/w using tobw. Note that such figures will appear 
  149. # in black and white online. 
  150. #
  151. # If you don't want a figure converted to GIF online, but kept in 
  152. # 24-bit RGB, use the RGB variable instead of the PRINT_COLOR variable.
  153. #
  154. # PRINT_COLOR = figure3.rgb figure4.rgb
  155.  
  156. PRINT_COLOR =
  157.  
  158. # Location 6: The PostScript Variable
  159. #
  160. # List the name of each PostScript figure in the orig directory that
  161. # should be remain PostScript in the print directory and convert to 
  162. # GIF online.
  163. #
  164. # PostScript = figure5.ps figure6.ai
  165.  
  166. PostScript =
  167.  
  168. # Location 7: The GIF Variable
  169. #
  170. # List the name of each .gif figure in the orig directory that
  171. # should be kept GIF in both the print and online directories.
  172. #
  173. # GIF = figure7.gif
  174.  
  175. GIF =
  176.  
  177. # Location 8: The RGB Variable
  178. #
  179. # List the name of each .rgb figure from the orig directory that
  180. # should be kept 24-bit RGB in both the print and online directories.
  181. #
  182. # RGB = figure8.rgb
  183.  
  184. RGB =
  185.  
  186. # Location 9: The XWD Variable
  187. #
  188. # List the name of each .xwd figure from the orig directory that
  189. # should be kept in XWD format in the print directory and converted 
  190. # to GIF online.
  191. #
  192. # XWD = figure9.xwd
  193.  
  194. XWD =
  195.  
  196. #
  197. # Location 10: The BW Variable
  198. #
  199. # List the name of each .bw figure from the orig directory that
  200. # has already been run through tobw and is referenced in your book
  201. # by it's .bw suffix
  202. #.
  203. # The files should not appear on any of the above PRINT_ lines.
  204. # These images will remain in black and white online as well.
  205. #
  206. # BW = figure10.bw
  207.  
  208. BW =
  209.  
  210. # Location 11: The INLINE_MEDIA Variable
  211. #
  212. # List the name of any inline media objects from the orig directory
  213. # that are referenced by your book.  These could be movie, audio, and
  214. # Inventor files.
  215. #
  216. # INLINE_MEDIA = movie.mv
  217.  
  218. INLINE_MEDIA = 
  219.  
  220. # Location 12: The MISC_FILES Variable
  221. #
  222. # List the name of any other files that you want to be installed in the
  223. # figures directory.  These files must exist in the orig directory and
  224. # would be files like the hot-spot data files, auxillary files for
  225. # the INLINE_MEDIA files, C program text, and any other files that
  226. # you absoluletly want to have installed with the book.
  227. #
  228. # NOTE: No QA testing will be done with these figures since they may
  229. # not be referenced directly by the SGML source file but rather indirectly
  230. # via other files.  These files will be copied down and shipped with the
  231. # book so make sure you don't list any cruft on this line.
  232. #
  233. # NOTE: If you do NOT have any figures that should be copied down - then
  234. # do NOT uncomment this line as an empty definition will break your build.
  235. # 
  236. # MISC_FILES = figure1.rgb.hot
  237.  
  238. # MISC_FILES =
  239.  
  240. include  ${COMMONBOOKRULES}
  241. include  ${COMMONPREPRULES}
  242.